/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.hibernate.qtags;

import org.xdoclet.plugin.hibernate.qtags.parameter.*;

/**
 * Declares a collection key. Strictly specking this tag is not necessary, as hibernate
 * will make a guess and produce some obscure column name for you. Collection key defined which column in
 * resulting table is to be used as reference to id of owner entity.
 *
 * @qtags.location method
 * @qtags.location field
 */
public interface HibernateKeyTag extends com.thoughtworks.qdox.model.DocletTag, Column, ForeignKey, Update, Unique,
    NotNull, PropertyRef {
    /**
     * Specifies whether the foreign key constraint has database-level cascade delete enabled.
     *
     * @qtags.allowed-value cascade
     * @qtags.allowed-value noaction
     */
    String getOnDelete();
}